Lufkin SAM EIE – Data Groups

Data Groups

With few exceptions, data groups must be defined in a device template file in order for them to be available for use on a remote device. Which data groups are defined by a device template file depends on protocol, device type, and unique configuration.

CygNet distributes sample device template files for its EIEs, each of which typically serves one or more hardware models along with applicable firmware. Therefore, the data groups described below are only those data groups defined by CygNet in sample device template file(s). Your template(s) might not include some of the data groups described below. Device template files exist to enable users to customize device configurations; however, CygNet is not responsible for changes made by users.

For information about data group definitions and device template files, see Device Template Files.

For more information about data group dependencies, see Data Group Dependencies.

Note: The device template file can include standard Modbus data groups and/or internal data groups (dgProtocol="Internal") with predefined values. Internal data groups contain components required by the driver, but they are unavailable to a user. Internal data groups cannot be modified.

Browse by letter: A C D E G H M P R S T W

Data Group Type	Usage Notes
AgaCfg	"AGA Config"
CardMisc	"Dynacard Misc Registers"
CfgMB	"Configurable Data"
CmdMsg	"Command Message"
Composite Data Group	The "Composite Data Group" is a special kind of data group that enables you to combine any data group element(s) from any data group(s) as long as they are in the same template as the composite data group. The "Composite Data Group" does not appear in a remote device editor unless it has been defined in the relevant device template file. See Composite Data Group.
CryoutCfg	"Cryout Configuration"
CtrlInfo	The "Controller Version Information" data group must be retrieved before requesting a failure card for the "Dynagraph Card" data group.
DateTime	"Date and Time"
Daylight	"Daylight Savings"
DownCfg	"Downhole Configuration"
DynaCard	The "Dynagraph Card" data group retrieves and displays surface and/or downhole rod pump cycle data. Data is displayed in table and graph format. These "Dynagraph Card" data groups are supported: Current Card: A current card describes the most recent stroke stored in the RTU. The device stores the last 5 current cards. Shutdown Card: A shutdown card, or pump-off card, is generated when the pump is turned off, usually to wait for the reservoir to fill. The device stores the last 5 shutdown cards in two card sets. Pumpup Card: A pumpup card is generated when the pump starts again after having been shut down. Reference Card: A quick reference or snapshot of a dynagraph card. Start Card: A start card is generated when the device restarts. Alarm Card: An alarm card is created whenever an alarm condition is met in a field device. The device does not have a dedicated alarm card buffer. Instead, the Shutdown Log is queried. If the latest entry is for an alarm event, the alarm card is obtained from the shutdown card buffer. The device stores the last 5 cards. Failure Card: A failure card is created whenever a fault condition is met in a field device. The device stores the last 5 cards. The "Controller Version Information" data group must be retrieved before requesting a failure card. The firmware version is used to determine which of two techniques to use to read failure cards. In firmware version 5.28, Lufkin created a dedicated failure card buffer. If the device is using this firmware version or later, failure cards are obtained from the failure card buffer. There are two failure card sets. If the device is using an earlier firmware version, the Shutdown Log is queried. If the latest entry is for a failure event, the failure card is obtained from the shutdown card buffer. The version at which to use the dedicated failure buffer can be overridden in the template file by setting the failureCardVersion attribute in the "Dynagraph Card "data group (e.g., failureCardVersion=”5.29”). This data group is required if you are connecting this device to the CygNet Dynagraph Viewer client application. Ordinals associated with the different data group types are hard coded. For instance, ordinal 0 is always Current Card, ordinal 1 is always Shutdown Card, and so forth. Ordinals here do not merely identify a sequence of "Dynagraph Card" data groups. Click Details for table-format plot data and other details. Click Save Reference to save the card being viewed as a reference card in CygNet. This card is not sent to the device. This data group references a specific subset of support data groups and elements. These items are required to support a connected system; they are not required if you are not reliant on a connected system for functionality or data.
DynaConfig	"Pumpoff Configuration"
EfmStat	"EFM Status"
GasAnal	"Gas Analysis"
GmrConfig	"FMS Legacy Configuration Data" requires AgaCfg and GasParms; ProgData for Contract Hour.
GmrEvent	"FMS Legacy Events Data" requires HistEvent and HistAlarm.
GmrHist	"FMS Legacy History Data" requires HistHourly.
HistAlarm	"History - Alarm"
HistDaily	"History - Daily"
HistEvent	"History - Event"
HistHourly	"History - Hourly"
MotorPower	"Motor Power Configuration"
PocCfgDown	"Downhole Pumpoff Configuration"
ProgData	"Program Data"
PumpUnit	"Pumping Unit Dimensions"
Runtime24	"Trend Data Runtime 24-Hour"
RunTimes	"Last 20 Runtimes"
SDLog	The "Shutdown Log" data group retrieves the Shutdown Log used for the Alarm card and Failure card in the "Dynagraph Card" data group.
SnglCoilRo	"Single Read-Only Coil"
SnglCoilRw	"Single Read/Write Coil"
SnglRegRo	"Single Read-Only Register"
SnglRegRw	"Single Read/Write Register"
StatusData	"Status Data"
Trend	The "Trend Data" data group can be configured to display several trends available from a Lufkin SAM device: for example, 24-Hour Gas Flow, 60-Day IPA History, 60-Day Minimum Load, 60-Day Peak Load, 60-Day Peak Torque, 60-Day Percent Runtime, 60-Day PIP Avg, 60-Day PIP Min, 60-Day PIP Peak, 60-Day Polish-Rod HP, 60-Day SWT Fluid, 60-Day SWT Gas, 60-Day SWT Oil, 60-Day SWT Oil+Water, 60-Day SWT Water, 60-Day Volume Flow.
WellConfig	"Well Configuration"

Data Group Type

Usage Notes

AgaCfg

"AGA Config"

CardMisc

"Dynacard Misc Registers"

CfgMB

"Configurable Data"

CmdMsg

"Command Message"

Composite Data Group

The "Composite Data Group" is a special kind of data group that enables you to combine any data group element(s) from any data group(s) as long as they are in the same template as the composite data group.

The "Composite Data Group" does not appear in a remote device editor unless it has been defined in the relevant device template file.

See Composite Data Group.

CryoutCfg

"Cryout Configuration"

CtrlInfo

The "Controller Version Information" data group must be retrieved before requesting a failure card for the "Dynagraph Card" data group.

DateTime

"Date and Time"

Daylight

"Daylight Savings"

DownCfg

"Downhole Configuration"

DynaCard

The "Dynagraph Card" data group retrieves and displays surface and/or downhole rod pump cycle data. Data is displayed in table and graph format.

These "Dynagraph Card" data groups are supported:

Current Card: A current card describes the most recent stroke stored in the RTU. The device stores the last 5 current cards.
Shutdown Card: A shutdown card, or pump-off card, is generated when the pump is turned off, usually to wait for the reservoir to fill. The device stores the last 5 shutdown cards in two card sets.
Pumpup Card: A pumpup card is generated when the pump starts again after having been shut down.
Reference Card: A quick reference or snapshot of a dynagraph card.
Start Card: A start card is generated when the device restarts.
Alarm Card: An alarm card is created whenever an alarm condition is met in a field device. The device does not have a dedicated alarm card buffer. Instead, the Shutdown Log is queried. If the latest entry is for an alarm event, the alarm card is obtained from the shutdown card buffer. The device stores the last 5 cards.
Failure Card: A failure card is created whenever a fault condition is met in a field device. The device stores the last 5 cards. The "Controller Version Information" data group must be retrieved before requesting a failure card. The firmware version is used to determine which of two techniques to use to read failure cards.

In firmware version 5.28, Lufkin created a dedicated failure card buffer. If the device is using this firmware version or later, failure cards are obtained from the failure card buffer. There are two failure card sets.
If the device is using an earlier firmware version, the Shutdown Log is queried. If the latest entry is for a failure event, the failure card is obtained from the shutdown card buffer.

The version at which to use the dedicated failure buffer can be overridden in the template file by setting the failureCardVersion attribute in the "Dynagraph Card "data group (e.g., failureCardVersion=”5.29”).

This data group is required if you are connecting this device to the CygNet Dynagraph Viewer client application.

Ordinals associated with the different data group types are hard coded. For instance, ordinal 0 is always Current Card, ordinal 1 is always Shutdown Card, and so forth. Ordinals here do not merely identify a sequence of "Dynagraph Card" data groups.

Click Details for table-format plot data and other details.

Click Save Reference to save the card being viewed as a reference card in CygNet. This card is not sent to the device.

This data group references a specific subset of support data groups and elements. These items are required to support a connected system; they are not required if you are not reliant on a connected system for functionality or data.

DynaConfig

"Pumpoff Configuration"

EfmStat

"EFM Status"

GasAnal

"Gas Analysis"

GmrConfig

"FMS Legacy Configuration Data" requires AgaCfg and GasParms; ProgData for Contract Hour.

GmrEvent

"FMS Legacy Events Data" requires HistEvent and HistAlarm.

GmrHist

"FMS Legacy History Data" requires HistHourly.

HistAlarm

"History - Alarm"

HistDaily

"History - Daily"

HistEvent

"History - Event"

HistHourly

"History - Hourly"

MotorPower

"Motor Power Configuration"

PocCfgDown

"Downhole Pumpoff Configuration"

ProgData

"Program Data"

PumpUnit

"Pumping Unit Dimensions"

Runtime24

"Trend Data Runtime 24-Hour"

RunTimes

"Last 20 Runtimes"

SDLog

The "Shutdown Log" data group retrieves the Shutdown Log used for the Alarm card and Failure card in the "Dynagraph Card" data group.

SnglCoilRo

"Single Read-Only Coil"

SnglCoilRw

"Single Read/Write Coil"

SnglRegRo

"Single Read-Only Register"

SnglRegRw

"Single Read/Write Register"

StatusData

"Status Data"

Trend

The "Trend Data" data group can be configured to display several trends available from a Lufkin SAM device: for example, 24-Hour Gas Flow, 60-Day IPA History, 60-Day Minimum Load, 60-Day Peak Load, 60-Day Peak Torque, 60-Day Percent Runtime, 60-Day PIP Avg, 60-Day PIP Min, 60-Day PIP Peak, 60-Day Polish-Rod HP, 60-Day SWT Fluid, 60-Day SWT Gas, 60-Day SWT Oil, 60-Day SWT Oil+Water, 60-Day SWT Water, 60-Day Volume Flow.

WellConfig

"Well Configuration"